/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.metadata.version;

import java.util.Date;
import java.util.List;
import org.hisp.dhis.common.GenericStore;

/**
 * Define MetadataStore to interact with the database.
 *
 * @author aamerm
 */
public interface MetadataVersionStore extends GenericStore<MetadataVersion> {
  String ID = MetadataVersionStore.class.getName();

  /**
   * @param id Key to lookup.
   * @return MetadataVersion Value that matched key, or null if there was no match.
   */
  MetadataVersion getVersionByKey(long id);

  /**
   * Get the version by name.
   *
   * @param versionName
   * @return MetadataVersion object matched by the name
   */
  MetadataVersion getVersionByName(String versionName);

  /**
   * Gets the current version in the system.
   *
   * @return MetadataVersion object which is the latest in the system
   */
  MetadataVersion getCurrentVersion();

  /**
   * Gets MetadataVersion 's based on start created and end created dates
   *
   * @param startDate
   * @param endDate
   * @return List of MetadataVersion objects lying in that range of dates
   */
  List<MetadataVersion> getAllVersionsInBetween(Date startDate, Date endDate);

  /**
   * @return Initial/First MetadataVersion of the system
   */
  MetadataVersion getInitialVersion();
}
